<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: Network.html 939 2015-05-29 01:16:17Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.kv.raft.net;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.io.IOException;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.nio.ByteBuffer;<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span>/**<a name="line.13"></a>
<span class="sourceLineNo">014</span> * Abstraction layer representing "the network", over which we communicate with other nodes.<a name="line.14"></a>
<span class="sourceLineNo">015</span> *<a name="line.15"></a>
<span class="sourceLineNo">016</span> * &lt;p&gt;<a name="line.16"></a>
<span class="sourceLineNo">017</span> * In general, messages may be delayed, dropped or delivered out of order. Specific implementations<a name="line.17"></a>
<span class="sourceLineNo">018</span> * may provide more strict guarantees.<a name="line.18"></a>
<span class="sourceLineNo">019</span> * &lt;/p&gt;<a name="line.19"></a>
<span class="sourceLineNo">020</span> *<a name="line.20"></a>
<span class="sourceLineNo">021</span> * &lt;p&gt;<a name="line.21"></a>
<span class="sourceLineNo">022</span> * Remote peers are identified by {@link String}s; the interpretation of these {@link String}s is up to the implementation.<a name="line.22"></a>
<span class="sourceLineNo">023</span> * &lt;/p&gt;<a name="line.23"></a>
<span class="sourceLineNo">024</span> *<a name="line.24"></a>
<span class="sourceLineNo">025</span> * &lt;p&gt;<a name="line.25"></a>
<span class="sourceLineNo">026</span> * Notifications are delivered to the specified {@link Handler}.<a name="line.26"></a>
<span class="sourceLineNo">027</span> * &lt;/p&gt;<a name="line.27"></a>
<span class="sourceLineNo">028</span> */<a name="line.28"></a>
<span class="sourceLineNo">029</span>public interface Network {<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>    /**<a name="line.31"></a>
<span class="sourceLineNo">032</span>     * Start this instance.<a name="line.32"></a>
<span class="sourceLineNo">033</span>     *<a name="line.33"></a>
<span class="sourceLineNo">034</span>     * @param handler handler for notifications<a name="line.34"></a>
<span class="sourceLineNo">035</span>     * @throws IllegalStateException if already started<a name="line.35"></a>
<span class="sourceLineNo">036</span>     * @throws IOException if an error occurs<a name="line.36"></a>
<span class="sourceLineNo">037</span>     */<a name="line.37"></a>
<span class="sourceLineNo">038</span>    void start(Handler handler) throws IOException;<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span>    /**<a name="line.40"></a>
<span class="sourceLineNo">041</span>     * Stop this instance.<a name="line.41"></a>
<span class="sourceLineNo">042</span>     *<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * &lt;p&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span>     * Does nothing if already stopped.<a name="line.44"></a>
<span class="sourceLineNo">045</span>     * &lt;/p&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span>     */<a name="line.46"></a>
<span class="sourceLineNo">047</span>    void stop();<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span>    /**<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * Send (or enqueue for sending) a message to a remote peer.<a name="line.50"></a>
<span class="sourceLineNo">051</span>     *<a name="line.51"></a>
<span class="sourceLineNo">052</span>     * &lt;p&gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span>     * If this method returns true, then {@link Handler#outputQueueEmpty Handler.outputQueueEmpty()}<a name="line.53"></a>
<span class="sourceLineNo">054</span>     * is guaranteed to be invoked with parameter {@code peer} at some later point.<a name="line.54"></a>
<span class="sourceLineNo">055</span>     *<a name="line.55"></a>
<span class="sourceLineNo">056</span>     * @param peer message destination<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * @param msg message to send<a name="line.57"></a>
<span class="sourceLineNo">058</span>     * @return true if message was succesfully enqueued for output; false if message failed to be delivered due to local reasons,<a name="line.58"></a>
<span class="sourceLineNo">059</span>     *  such as failure to initiate a new connection or output queue overflow<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * @throws IllegalArgumentException if {@code peer} cannot be interpreted<a name="line.60"></a>
<span class="sourceLineNo">061</span>     * @throws IllegalArgumentException if {@code peer} or {@code msg} is null<a name="line.61"></a>
<span class="sourceLineNo">062</span>     */<a name="line.62"></a>
<span class="sourceLineNo">063</span>    boolean send(String peer, ByteBuffer msg);<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span>// Handler<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span>    /**<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * Callback interface used by {@link Network} implementations.<a name="line.68"></a>
<span class="sourceLineNo">069</span>     */<a name="line.69"></a>
<span class="sourceLineNo">070</span>    public interface Handler {<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span>        /**<a name="line.72"></a>
<span class="sourceLineNo">073</span>         * Handle an incoming message from a remote peer.<a name="line.73"></a>
<span class="sourceLineNo">074</span>         *<a name="line.74"></a>
<span class="sourceLineNo">075</span>         * &lt;p&gt;<a name="line.75"></a>
<span class="sourceLineNo">076</span>         * The {@code msg} buffer is read-only; its contents are not guaranteed to be valid after this method returns.<a name="line.76"></a>
<span class="sourceLineNo">077</span>         *<a name="line.77"></a>
<span class="sourceLineNo">078</span>         * @param peer message source<a name="line.78"></a>
<span class="sourceLineNo">079</span>         * @param msg message received<a name="line.79"></a>
<span class="sourceLineNo">080</span>         */<a name="line.80"></a>
<span class="sourceLineNo">081</span>        void handle(String peer, ByteBuffer msg);<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span>        /**<a name="line.83"></a>
<span class="sourceLineNo">084</span>         * Receive notification that a remote peer's output queue has transitioned from a non empty state to an empty state<a name="line.84"></a>
<span class="sourceLineNo">085</span>         *<a name="line.85"></a>
<span class="sourceLineNo">086</span>         * @param peer remote peer<a name="line.86"></a>
<span class="sourceLineNo">087</span>         */<a name="line.87"></a>
<span class="sourceLineNo">088</span>        void outputQueueEmpty(String peer);<a name="line.88"></a>
<span class="sourceLineNo">089</span>    }<a name="line.89"></a>
<span class="sourceLineNo">090</span>}<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>




























































</pre>
</div>
</body>
</html>
